Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifications about running dbt init --profile #4534

Merged
merged 16 commits into from
Dec 19, 2023
Merged

Clarifications about running dbt init --profile #4534

merged 16 commits into from
Dec 19, 2023

Conversation

victorrgez
Copy link
Contributor

@victorrgez victorrgez commented Nov 26, 2023

Clarifications about running dbt init --profile

What are you changing in this pull request and why?

-Clarify the use of dbt init when using an existing profiles.yml file. The current docs are not clear enough and one may think you have to provide the path to profiles.yml as an argument, for example, dbt init --profile profiles.yml when, in fact, you need to pass the actual name of your profile.


REMOVED CHANGES:

-Clarify that you cannot pass the --profile flag if you already have a dbt_project.yml file as the error returned (Can not init existing project with specified profile, edit dbt_project.yml instead) may be confusing

-Change VersionBlock version from 1.7 to 1.8

Checklist

Clarifications about running dbt init --profile
@victorrgez victorrgez requested a review from a team as a code owner November 26, 2023 11:34
Copy link

welcome bot commented Nov 26, 2023

Hello!👋 Thanks for contributing to the dbt product documentation and opening this pull request! ✨
We use Markdown and some HTML to write the dbt product documentation. When writing content, you can use our style guide and content types to understand our writing standards and how we organize information in the dbt product docs.
We'll review your contribution and respond as soon as we can. 😄

Copy link

vercel bot commented Nov 26, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 19, 2023 1:17pm

@runleonarun runleonarun added the new contributor Label for first-time contributors label Nov 26, 2023
@github-actions github-actions bot added content Improvements or additions to content size: x-small This change will take under 3 hours to fix. labels Nov 26, 2023
@victorrgez victorrgez changed the title Update init.md Clarifications about running dbt init --profile Nov 26, 2023
Copy link
Member

@aranke aranke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 change looks good, not sure about other 2

website/docs/reference/commands/init.md Show resolved Hide resolved
website/docs/reference/commands/init.md Outdated Show resolved Hide resolved

When using `dbt init` to initialize your project, include the `--profile` flag to specify an existing `profiles.yml` as the `profile:` key to use instead of creating a new one. For example, `dbt init --profile`.
When using `dbt init` to initialize your project, include the `--profile` flag to specify an existing `profiles.yml` as the `profile:` key to use instead of creating a new one. For example, `dbt init --profile profile_name`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch!

Resolved comments on PR
@victorrgez
Copy link
Contributor Author

Sorry about the other two changes. They were the result of a misunderstanding.

Thank you @aranke for your time reviewing the PR!

Copy link
Member

@aranke aranke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, ty!

@victorrgez
Copy link
Contributor Author

Hi @aranke

I'm not authorised to merge the PR, could you please do it or is there something else left to do first?

thanks!

@mirnawong1 mirnawong1 enabled auto-merge December 19, 2023 13:04
@mirnawong1
Copy link
Contributor

hey @victorrgez and @aranke -- thank you so much for contributing and merging this PR for you now, Victor!

@mirnawong1 mirnawong1 merged commit 7a28340 into dbt-labs:current Dec 19, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content new contributor Label for first-time contributors size: x-small This change will take under 3 hours to fix.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants